feat: Add support for Guild Scheduled Event Recurrence #2749

DA-344 · 2025-03-23T18:56:35Z

Summary

Adds support for receiving, setting, and updating a Scheduled Event's recurrence rule.

Documentation: resources/guild-scheduled-event

Needs testing.

Information

This PR fixes an issue.
This PR adds something new (e.g. new method or parameters).
This PR is a breaking change (e.g. methods or parameters removed/renamed).
This PR is not a code change (e.g. documentation, README, typehinting,
examples, ...).

Checklist

I have searched the open pull requests for duplicates.
If code changes were made then they have been tested.
- I have updated the documentation to reflect the changes.
If type: ignore comments were used, a comment is also left explaining why.
I have updated the changelog to include these changes.

discord/scheduled_events.py

Co-authored-by: plun1331 <plun1331@gmail.com> Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

discord/scheduled_events.py

… into feat/recurrence-rule

plun1331 · 2025-05-09T19:15:54Z

discord/scheduled_events.py

+        If this recurrence rule was obtained from the API you will need to
+        :meth:`.copy` it in order to edit it.


one more question... why?

This class seems to serve more as a dataclass-ish than an API object. Which is fine, but having an edit method here, and then disallowing editing attributes seems weird. This class should realistically not even hold self._state (I believe). It would probably make everything easier.

Lulalaby · 2025-08-02T03:25:47Z

Merge conflicts
(complicated discord feature, requires intense testing)

docs/api/enums.rst

Lulalaby · 2025-09-01T20:03:33Z

@DA-344 went ahead and fixed the merge conflicts for you. please double check

Paillat-dev · 2025-09-01T20:00:31Z

discord/scheduled_events.py

+        If this recurrence rule was obtained from the API you will need to
+        :meth:`.copy` it in order to edit it.


discord/scheduled_events.py

Paillat-dev · 2025-09-30T13:50:06Z

discord/guild.py

        image: Optional[:class:`bytes`]
-            The cover image of the scheduled event
+            The cover image of the scheduled event.
+        recurrence_rule: Optional[:class:`ScheduledEventRecurrenceRule`]


If this is provided, is start_date ignored ?

Signed-off-by: Lumouille <144063653+Lumabots@users.noreply.github.com>

Signed-off-by: Lala Sabathil <lala@pycord.dev>

Paillat-dev

Also see merge conflicts

discord/scheduled_events.py

Paillat-dev · 2025-12-10T11:44:43Z

discord/scheduled_events.py

+        return f"<ScheduledEventRecurrenceRule start_date={self.start_date} frequency={self.frequency} interval={self.interval}>"
+
+    @property
+    def weekdays(self) -> list[ScheduledEventWeekday]:


I've been thinking about this again. If you can, I think we should just make these normal attributes. Realistically, it's more likely to confuse someone than prevent misuse. See my comment on edit below as well

i think that these should be properties so when users set a new value (rrule.weekdays = [...]) the required processing and checks can be done so the payload sent when using _to_dict() is correctly formatted

None of there properties process anything, all they do is returning a copy (which again i don't think we should do, to be honest with you as I mentioned somewhere else this could have been a dataclass), and if there's any processing to be done it can be done in _to_dict directly.

i meant on the setters lol.
but now they do not return copies, i don't remember in which commit i changed that (in which i forgot to update the docstring)

Oh yeah, I just checked the docstring.

Paillat-dev · 2025-12-10T11:46:16Z

discord/scheduled_events.py

+        If this recurrence rule was obtained from the API you will need to
+        :meth:`.copy` it in order to edit it.


This class seems to serve more as a dataclass-ish than an API object. Which is fine, but having an edit method here, and then disallowing editing attributes seems weird. This class should realistically not even hold self._state (I believe). It would probably make everything easier.

Co-authored-by: Paillat <paillat@pycord.dev> Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

Lumabots · 2025-12-12T06:48:47Z

discord/scheduled_events.py

+        self.exceptions: list[Object] = list(
+            map(
+                Object,
+                data.get("guild_scheduled_events_exceptions") or [],


i cant find any docs on guild_scheduled_events_exceptions, could you link one to me ?

https://docs.discord.food/resources/guild-scheduled-event#:~:text=guild_scheduled_event_exceptions

well so its not documented by discord it shouldnt be here imo

I made this before exceptions were changed, but yeah, I will remove them (I think i already did, or maybe i just didn't push the commit)

discord/scheduled_events.py

Paillat-dev · 2025-12-12T09:44:05Z

discord/scheduled_events.py

+        *,
+        weekdays: list[WeekDay | ScheduledEventWeekday] = MISSING,
+        n_weekdays: list[NWeekDay] = MISSING,
+        month_days: list[datetime.date] = MISSING,


How does this work with two different days on two different months ? Realistically that would end up to 4x a year instead of 2x a year when casted into discord's api's format

Yeah, that would end up with 2 pairs of days on by_month and by_month_day, maybe adding a note saying that the API currently supports "1 month day".

Imo this should just accept a list of ints, it would just be clearer and more importantly closer to the Discord API

i can make it so it can take both datetime.date or a sequence of tuple of ints (with a structure like (month, day)), or just change to a format, although the latter seems like a worse ux design when we can use built-in dataclasses specifically made for representing month days.

I feel like having both would be confusing (in general, we are trying to avoid adding many ways of doing things, this is a recurring issue in py-cord), and having only datetime.date isn't correctly representative.

cc @plun1331 do you have an idea ?

… into feat/recurrence-rule

JustaSqu1d · 2026-01-13T08:55:36Z

discord/enums.py

+    daily = 3
+
+
+class ScheduledEventWeekday(Enum):


Weekday implies the days of the typical working week Monday through Friday. Maybe we can use DayOfWeek?

docs/api/enums.rst

JustaSqu1d · 2026-01-13T09:00:21Z

docs/api/enums.rst

+
+    .. attribute:: monday
+
+        Monday, the first day of the week. Index of 0.


Not to get political, the first day of the week is not internationally recognized as Monday. Personally, I think we can just drop "the [x] day of the week" from the documentation, as a reasonable individual should know what a Monday is.

yeah that makes sense, will do.

CHANGELOG.md

Lumabots · 2026-01-16T08:16:14Z

Not wanting to be disrespectful or anything, but it’s been some time since this hasn’t been updated or fixed as it’s implementing, if I understand correctly, a wrong/limited usage of schedule event (see Paillat comment).
So should we switch in a way to #3025, which also implements this, fixing the current issue with the month days and month numbers? And imo the read only is a bit weird not saying for dpy but in py-cord we pretty much have nothing as read only so it disturb me a bit
Since it’s also fixing a bunch of other stuff, overload, etc. (unrelated to guild even recurrence)
Please let me now

Paillat-dev · 2026-01-16T10:25:34Z

As I already mentioned somewhere (forgot where) this PR should focus on Event Recurrence, and #3025 should focus on fixing the caching and parsing issues currently present.

@DA-344 Are you still planning to work on this ? There's a couple comments to be addressed.

Co-authored-by: JustaSqu1d <89910983+JustaSqu1d@users.noreply.github.com> Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

DA-344 added 2 commits March 23, 2025 19:52

feat: Add support for scheduled event recurrence

c95dfe5

merge branch 'master' from https://github.com/Pycord-Development/pycord

1d824da

DA-344 requested a review from a team as a code owner March 23, 2025 18:56

pullapprove4 bot requested a review from VincentRPS March 23, 2025 18:56

pullapprove4 bot added PA: All Contributors pending PA: Maintainers pending labels Mar 23, 2025

pre-commit-ci bot and others added 3 commits March 23, 2025 18:57

style(pre-commit): auto fixes from pre-commit.com hooks

e87b93d

oops

476d106

style(pre-commit): auto fixes from pre-commit.com hooks

14ebe20

plun1331 reviewed Mar 31, 2025

View reviewed changes

DA-344 and others added 3 commits April 1, 2025 09:53

update scheduled_events.py

2fed715

Co-authored-by: plun1331 <plun1331@gmail.com> Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

chore: do some things i dont remember

2e6cfa9

style(pre-commit): auto fixes from pre-commit.com hooks

548304a

Icebluewolf reviewed Apr 4, 2025

View reviewed changes

discord/scheduled_events.py Outdated Show resolved Hide resolved

DA-344 added 3 commits April 9, 2025 19:41

chore: Replace 24 to 4

dca1557

Merge branch 'feat/recurrence-rule' of https://github.com/da-344/pycord…

a66bbd8

… into feat/recurrence-rule

chore: Add changelog

0389bc1

plun1331 reviewed May 9, 2025

View reviewed changes

Paillat-dev added API reflection Discord API isn't correctly reflected hold: testing This pull request requires further testing labels Aug 6, 2025

Lulalaby added the on hold label Aug 30, 2025

Lulalaby requested a review from a team as a code owner August 30, 2025 20:33

Lulalaby force-pushed the master branch 2 times, most recently from b55c125 to 82659b2 Compare August 30, 2025 21:10

Lulalaby removed the on hold label Aug 30, 2025

Lulalaby requested a review from a team as a code owner September 1, 2025 12:31

Paillat-dev self-assigned this Sep 1, 2025

Paillat-dev self-requested a review September 1, 2025 15:41

Paillat-dev reviewed Sep 1, 2025

View reviewed changes

docs/api/enums.rst Outdated Show resolved Hide resolved

Lulalaby force-pushed the master branch from 6529ef4 to 9855a4e Compare September 1, 2025 22:02

Paillat-dev reviewed Sep 30, 2025

View reviewed changes

Lumabots and others added 3 commits October 20, 2025 22:01

Merge branch 'master' into feat/recurrence-rule

032d7c5

Signed-off-by: Lumouille <144063653+Lumabots@users.noreply.github.com>

Merge branch 'master' into feat/recurrence-rule

f556991

Signed-off-by: Lala Sabathil <lala@pycord.dev>

Merge branch 'master' into feat/recurrence-rule

73ad285

Paillat-dev requested changes Dec 10, 2025

View reviewed changes

pullapprove4 bot removed PA: All Contributors pending PA: Maintainers pending labels Dec 10, 2025

Paillat-dev added the priority: medium Medium Priority label Dec 10, 2025

Update or check

3ca31c7

Co-authored-by: Paillat <paillat@pycord.dev> Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

Lumabots reviewed Dec 12, 2025

View reviewed changes

Paillat-dev requested changes Dec 12, 2025

View reviewed changes

discord/scheduled_events.py Show resolved Hide resolved

discord/scheduled_events.py Show resolved Hide resolved

Paillat-dev reviewed Dec 12, 2025

View reviewed changes

discord/scheduled_events.py Show resolved Hide resolved

Paillat-dev reviewed Dec 12, 2025

View reviewed changes

DA-344 added 2 commits December 17, 2025 18:16

add overloads

0aff636

Merge branch 'feat/recurrence-rule' of https://github.com/da-344/pycord…

87ba631

… into feat/recurrence-rule

Lulalaby added the on hold label Dec 24, 2025

Lulalaby force-pushed the master branch from cb403d2 to 7bb2a2d Compare December 24, 2025 15:42

Lulalaby added this to the v2.8 milestone Dec 24, 2025

Lulalaby removed the on hold label Dec 24, 2025

JustaSqu1d requested changes Jan 13, 2026

View reviewed changes

DA-344 and others added 6 commits January 19, 2026 20:05

Update CHANGELOG.md

6822c67

Co-authored-by: JustaSqu1d <89910983+JustaSqu1d@users.noreply.github.com> Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

Update docs/api/enums.rst

8414de0

Co-authored-by: JustaSqu1d <89910983+JustaSqu1d@users.noreply.github.com> Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

update enum docs

990319a

merge upstream

e544abd

merge master

7e29ec6

style(pre-commit): auto fixes from pre-commit.com hooks

dce1229

		If this recurrence rule was obtained from the API you will need to
		:meth:`.copy` it in order to edit it.


		.. attribute:: monday

		Monday, the first day of the week. Index of 0.

Uh oh!

feat: Add support for Guild Scheduled Event Recurrence #2749

Are you sure you want to change the base?

feat: Add support for Guild Scheduled Event Recurrence #2749

Conversation

DA-344 commented Mar 23, 2025

Summary

Information

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Lulalaby commented Aug 2, 2025

Uh oh!

Uh oh!

Lulalaby commented Sep 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Paillat-dev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Lumabots commented Jan 16, 2026 •

edited

Loading